<?php

/**
 * EXHIBIT A. Common Public Attribution License Version 1.0
 * The contents of this file are subject to the Common Public Attribution License Version 1.0 (the “License”);
 * you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.oxwall.org/license. The License is based on the Mozilla Public License Version 1.1
 * but Sections 14 and 15 have been added to cover use of software over a computer network and provide for
 * limited attribution for the Original Developer. In addition, Exhibit A has been modified to be consistent
 * with Exhibit B. Software distributed under the License is distributed on an “AS IS” basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language
 * governing rights and limitations under the License. The Original Code is Oxwall software.
 * The Initial Developer of the Original Code is Oxwall Foundation (http://www.oxwall.org/foundation).
 * All portions of the code written by Oxwall Foundation are Copyright (c) 2011. All Rights Reserved.

 * EXHIBIT B. Attribution Information
 * Attribution Copyright Notice: Copyright 2011 Oxwall Foundation. All rights reserved.
 * Attribution Phrase (not exceeding 10 words): Powered by Oxwall community software
 * Attribution URL: http://www.oxwall.org/
 * Graphic Image as provided in the Covered Code.
 * Display of Attribution Information is required in Larger Works which are defined in the CPAL as a work
 * which combines Covered Code or portions thereof with code not governed by the terms of the CPAL.
 */

/**
 * Data Transfer Object for `user` table.  
 * 
 * @author Sardar Madumarov <madumarov@gmail.com>
 * @package ow_system_plugins.base.bol
 * @since 1.0
 */
class BOL_User extends OW_Entity
{
    /**
     * @var string
     */
    public $email;
    /**
     * @var string
     */
    public $username;
    /**
     * @var string
     */
    public $password;
    /**
     * @var integer
     */
    public $joinStamp;
    /**
     * @var integer
     */
    public $activityStamp;
    /**
     * @var string
     */
    public $accountType;
    /**
     * @var boolean
     */
    public $emailVerify = false;
    /**
     * @var int
     */
    public $joinIp = 0;

    /**
     * @return integer
     */
    public function getActivityStamp()
    {
        return $this->activityStamp;
    }

    /**
     * @return string
     */
    public function getEmail()
    {
        return $this->email;
    }

    /**
     * @return integer
     */
    public function getJoinStamp()
    {
        return $this->joinStamp;
    }

    /**
     * @return string
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * @return string
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * @return integer
     */
    public function getAccountType()
    {
        return $this->accountType;
    }

    /**
     * @return boolean
     */
    public function getEmailVerify()
    {
        return (boolean) $this->emailVerify;
    }

    /**
     * @return int
     */
    public function getJoinIp()
    {
        return (boolean) $this->joinIp;
    }

    /**
     * @param integer $activityStamp
     * @return BOL_User
     */
    public function setActivityStamp( $activityStamp )
    {
        $this->activityStamp = (int) $activityStamp;

        return $this;
    }

    /**
     * @param string $email
     * @return BOL_User
     */
    public function setEmail( $email )
    {
        $this->email = trim($email);

        return $this;
    }

    /**
     * @param integer $joinStamp
     * @return BOL_User
     */
    public function setJoinStamp( $joinStamp )
    {
        $this->joinStamp = (int) $joinStamp;

        return $this;
    }

    /**
     * @param string $password
     * @return BOL_User
     */
    public function setPassword( $password )
    {
        $this->password = trim($password);

        return $this;
    }

    /**
     * @param string $username
     * @return BOL_User
     */
    public function setUsername( $username )
    {
        $this->username = trim($username);

        return $this;
    }

    /**
     * @param integer $accountType
     * @return BOL_User
     */
    public function setAccountType( $accountType )
    {
        $this->accountType = $accountType;

        return $this;
    }

    /**
     * @return boolean
     */
    public function setEmailVerify( $emailVerify )
    {
        $this->emailVerify = (boolean) $emailVerify;
        return $this;
    }

        /**
     * @param int $ip
     * @return BOL_User
     */
    public function setJoinIp( $ip )
    {
        $this->joinIp = (int)$ip;

        return $this;
    }
}